/****************************************************************************
**
** This file is part of the KD Chart library.
**
** SPDX-FileCopyrightText: 2001-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
**
** SPDX-License-Identifier: MIT
**
****************************************************************************/

#ifndef KDCHARTRULERATTRIBUTES_H
#define KDCHARTRULERATTRIBUTES_H

#include "KDChartEnums.h"
#include "KDChartGlobal.h"
#include <QMetaType>

QT_BEGIN_NAMESPACE
class QPen;
QT_END_NAMESPACE

namespace KDChart {

/**
 * @brief A set of attributes controlling the appearance of axis rulers
 */
class KDCHART_EXPORT RulerAttributes
{
public:
    RulerAttributes();
    RulerAttributes(const RulerAttributes &);
    RulerAttributes &operator=(const RulerAttributes &);

    ~RulerAttributes();

    /**
     * Sets the pen used to draw the tick marks
     */
    void setTickMarkPen(const QPen &pen);
    QPen tickMarkPen() const;

    /**
     * Sets the pen used to draw major tick marks
     */
    void setMajorTickMarkPen(const QPen &pen);
    bool majorTickMarkPenIsSet() const;
    QPen majorTickMarkPen() const;

    /**
     * Sets the pen used to draw minor tick marks
     */
    void setMinorTickMarkPen(const QPen &pen);
    bool minorTickMarkPenIsSet() const;
    QPen minorTickMarkPen() const;

    /**
     * Sets the pen used to draw the tick mark at a specific value
     *
     * Note: This will not paint a tick mark at the specified value
     * if it wasn't already drawn before.
     */
    void setTickMarkPen(qreal value, const QPen &pen);
    QPen tickMarkPen(qreal value) const;
    typedef QMap<qreal, QPen> TickMarkerPensMap;
    TickMarkerPensMap tickMarkPens() const;

    bool hasTickMarkPenAt(qreal value) const;

    /**
     * Color setter method provided for convenience
     */
    void setTickMarkColor(const QColor &color);
    QColor tickMarkColor() const;

    /**
     * Shows or hides minor tick marks
     */
    void setShowMinorTickMarks(bool show);
    bool showMinorTickMarks() const;

    void setShowRulerLine(bool show);
    bool showRulerLine() const;

    /**
     * Shows or hides major tick marks
     */
    void setShowMajorTickMarks(bool show);
    bool showMajorTickMarks() const;

    /**
     * Sets the length of major tick marks
     */
    void setMajorTickMarkLength(int length);
    int majorTickMarkLength() const;
    bool majorTickMarkLengthIsSet() const;

    /**
     * Sets the length of minor tick marks
     */
    void setMinorTickMarkLength(int length);
    int minorTickMarkLength() const;
    bool minorTickMarkLengthIsSet() const;

    /**
     * Set margin that should be used between the labels and the ticks. By
     * default the value is -1, which means that half of the label's font
     * height/width should be used as margin.
     */
    void setLabelMargin(int margin);
    int labelMargin() const;

    /**
     * Shows or hides the first tick. This is usually where the axes cross.
     * The tick itself may be obscured by the other axis, but the label will be visible.
     */
    void setShowFirstTick(bool show);
    bool showFirstTick() const;

    bool operator==(const RulerAttributes &) const;
    inline bool operator!=(const RulerAttributes &other) const
    {
        return !operator==(other);
    }

private:
    KDCHART_DECLARE_PRIVATE_BASE_VALUE(RulerAttributes)
}; // End of class RulerAttributes
}

#if !defined(QT_NO_DEBUG_STREAM)
KDCHART_EXPORT QDebug operator<<(QDebug, const KDChart::RulerAttributes &);
#endif /* QT_NO_DEBUG_STREAM */

KDCHART_DECLARE_SWAP_SPECIALISATION(KDChart::RulerAttributes)

QT_BEGIN_NAMESPACE
Q_DECLARE_TYPEINFO(KDChart::RulerAttributes, Q_MOVABLE_TYPE);
QT_END_NAMESPACE

Q_DECLARE_METATYPE(KDChart::RulerAttributes)

#endif // KDCHARTRULERATTRIBUTES_H
